/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.model.api;

import java.util.Iterator;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * A factory for processing data from a JoinTagParser.
 *
 */
public class JoinTagFactory
implements Iterator<JoinTag>
    {
    /**
     * Our debug logger.
     * 
     */
    private static Log log = LogFactory.getLog(JoinTagFactory.class);

    /**
     * Public constructor.
     *
     */
    public JoinTagFactory(Account account, JoinTagParser parser)
        {
        this.parser  = parser  ;
        this.account = account ;
        }

    /**
     * Our JoinTag parser.
     *
     */
    private JoinTagParser parser ;

    /**
     * The Account to create the tags for.
     *
     */
    private Account account ;


    @Override
    public boolean hasNext()
        {
        return parser.hasNext();
        }

    @Override
    public JoinTag next()
        {
        log.debug("JoinTagFactory.next()");
        return account.tag(
            parser.next()
            );
        }

    @Override
    public void remove()
        {
        throw new UnsupportedOperationException(
            "Iterator.remove() not supported"
            );
        }
    }

